/*
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */

package org.erossi.pigest.model.unitamisura;

import java.util.HashSet;
import java.util.Set;

import org.erossi.common.model.GenericBean;
import org.erossi.common.util.AppCtx;
import org.erossi.pigest.model.articolo.Articolo;

/**
 * 'UnitaMisura' class: bean che rappresenta l'entità "Unità di Misura"
 *
 * @author erossi
 * @version Jan 13, 2008
 */
public class UnitaMisura extends GenericBean {

  private static final long serialVersionUID = 1L;

  private String nome;
  private Set<Articolo> articoli;
  
  /**
   * Crea una nuova istanza della classe
   */
  public UnitaMisura() {
    
    nome = null;
    articoli = new HashSet<Articolo>();
    
  }
  
  /**
   * Aggiunge un articolo all'elenco degli articoli per l'unità di misura.
   * 
   * <p>
   *   Questo metodo é creato per gestire l'associazione con l'entità
   *   {@link org.erossi.pigest.model.articolo.Articolo},
   * </p>
   * 
   * @param articolo l'articolo da aggiungere all'elenco degli articoli
   */
  public void aggiungiArticolo(Articolo articolo) {
    
    articoli.add(articolo);
    articolo.setUnitaMisura(this);
  
  } 

  /**
   * Verifica l'uguaglianza fra due oggetti.
   * 
   * <p>
   *   Nel confronto vengono verificati gli attributi significativi del bean
   *   {@link org.erossi.pigest.model.unitamisura.UnitaMisura}, ovvero sono esclusi quelli che 
   *   appartengono al bean generico {@link org.erossi.common.model.GenericBean}
   *   che il primo estende.
   * </p>
   * <p>
   *   Sono esclusi dalla verifica gli attributi che costituiscono le associazioni/chiavi esterne.
   * </p>
   * <p>
   *   L'uguaglianza verificata é quindi quella <b>semantica</b>.
   * </p>
   * 
   * @param o l'oggetto di cui verificare l'uguaglianza
   */
  public boolean equals (Object o) {

    if (o == null) return false;
    if (!(o instanceof UnitaMisura)) return false;
    if (this == o) return true;  
    
    boolean equals = false;
    
    UnitaMisura unitaMisura = (UnitaMisura) o;
    
    if (super.nullSafeEquals(unitaMisura.getNome(), this.getNome())) {
      equals = true;
    }
    
    return equals;
    
  }
  
  /**
   * Calcola l'hash per l'oggetto corrente.
   * 
   * <p>
   *   L'hash dell'oggetto é calcolato come somma degli hash dei suoi attributi,
   *   esclusi quelli che appartengono al bean generico 
   *   {@link org.erossi.common.model.GenericBean}.
   * </p>
   * <p>
   *   Sono esclusi dalla verifica gli attributi che costituiscono le associazioni/chiavi esterne.
   * </p>
   * 
   * @return l'hash corrispondente all'oggetto corrente
   */
  public int hashCode() {
    
    int hashCode = 0;
    
    if(this.getNome() != null) {hashCode += this.getNome().hashCode();}
  
    return hashCode;
   
  }
  
  /**
   * Imposta il valore dell'attributo 'articoli'
   * 
   * <p>
   *   Il metodo non gestisce la biunivocità della relazione. Utilizzare il metodo
   *   {@link org.erossi.pigest.model.unitamisura.UnitaMisura#aggiungiArticolo(Articolo)},
   *   che garantisce la corretta associazione biunivoca fra le entità.
   * </p>
   * 
   * @param articoli il valore dell'attributo 'articoli'
   */
  public void setArticoli(Set<Articolo> articoli) {
    this.articoli = articoli;
  }
  
  /**
   * Ritorna una rappresentazione sotto forma di 
   *   stringa dell'oggetto.
   * 
   * @return una stringa che rappresenta l'oggetto
   */
  public String toString() {

    String toString = new String();
    toString = this.getClass().getName();
    
    toString += AppCtx.printDebug("super", super.toString());
    toString += AppCtx.printDebug("nome", nome);

    return toString;

  }

  /**
   * Restituisce il valore dell'attributo 'nome'
   * @return il valore dell'attributo nome
   */
  public String getNome() {
    return this.nome;
  }

  /**
   * Imposta il valore dell'attributo 'nome'
   * @param nome il valore dell'attributo 'nome'
   */
  public void setNome(String nome) {
    this.nome = nome;
  }
  
  /**
   * Restituisce il valore dell'attributo 'articoli'
   * @return il valore dell'attributo articoli
   */
  public Set<Articolo> getArticoli() {
    return this.articoli;
  }

}

